IBM Endpoint Manager Inspectors Reference

Terminology

Win: Windows
Lin: Red Hat and SUSE Linux
Sol: SUN Solaris
HPUX: Hewlett-Packard UNIX version
AIX: IBM AIX
Mac: Apple Macintosh
Ubu: Ubuntu/Debian
WM: Windows Mobile

The version (e.g. Lin:8.1) corresponds to the version of the IEM product (8.1) in which the inspector was introduced in the client on that platform.
The version number is not shown if it is less than 8.0.


Platform


Contents

Action Objects
Authorization Objects
Client Objects
Directory Services
Environment Objects
Filesystem Objects
Firewall Objects
Fixlet Objects
Formatting Objects
Installed System Software
Introspectors
License Objects
Microsoft IIS Metabase Objects
Miscellaneous
Networking Objects
Power Objects
Primitive Objects
Registry Objects
Session Objects
Session Statistics
Site Objects
bes site
bes site set
bes site with multiplicity
site
site group
site version list
site version list with multiplicity
SMBIOS objects
System Objects
Task Objects
User Objects
Windows Mobile Device Objects
WMI Objects
World Objects

IBM Endpoint Manager wiki

Site Objects

These keywords query the properties of Fixlet sites to which the client is subscribed.

site

A <site> object is provided to access properties of Fixlet sites.

Creation Methods

DeclarationDescriptionPlatforms (?)
current siteReturns the current site object. See site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
siteReturns all the site objects that are currently loaded into memory. See site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
site <string>Returns a site object for the name provided. The name is the URL of the site location. See site.

Example:
exists site "actionsite" - TRUE when the action site exists on the target machine.

Example:
masthead path of site "BESSupport" - Typically returns a string such as: Macintosh HD:private:var:root:Library:Preferences:BigFix Enterprise:BES Support:__Local:Masthead.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
site of <fixlet>Returns the site corresponding to the specified Fixlet message.Win:8.1, Lin:8.1, Sol:8.1, HPUX:8.1, AIX:8.1, Mac:8.1, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
client folder of <site><folder>

Plural: client folders
The folder containing the site content on the client machine. Site content is gathered into this location.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
evaluated of <site><boolean>

Plural: evaluateds
Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
fixlet of <site><fixlet>

Plural: fixlets
Iterates through the Fixlet messages of the specified site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
gather schedule authority of <site><string>

Plural: gather schedule authoritys
Returns a string corresponding to the authority of the site schedule, for example: Publisher, Custom, Manual or Disabled.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
gather schedule time interval of <site><time interval>

Plural: gather schedule time intervals
Returns the time interval between automatic gathering of site content.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
group <integer> of <site><site group>

Plural: groups
Returns an object corresponding to the numbered group of the specified site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
last gather time of <site><time>

Plural: last gather times
Returns the time of last successful gathering from the site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
masthead of <site><file>

Plural: mastheads
Each site has a masthead, and the masthead is saved into the site data folder upon successful creation. This property returns a file object that corresponds to the copy in the site data folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
name of <site><string>

Plural: names
The name of the site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
relevant fixlet of <site><fixlet>

Plural: relevant fixlets
Iterates through the Relevant Fixlet messages for the specified site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
relevant offer action of <site><action>

Plural: relevant offer actions
Returns the list of relevant actions that are offers for the specified site. This Inspector could be useful in a client UI dashboard listing the current set of relevant offers.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
setting <string> of <site><setting>

Plural: settings
Returns the setting whose name matches the string provided from the Fixlet site settings.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
setting of <site><setting>

Plural: settings
Returns one or more settings from the site settings.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
site tag of <site><string>

Plural: site tags
Returns the last component of the specified site's url, eg. 'actionsite', 'enteprisesecurity', etcetera.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
site version list of <site><site version list>

Plural: site version lists
Returns the last gathered site version list (manyversion) of the specified site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
subscribe time of <site><time>

Plural: subscribe times
Returns the time that the current machine began subscribing to the site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
type of <site><string>

Plural: types
Returns one of the following 4 literal strings:Master Action SiteOperator SiteCustom SiteFixlet Site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
url of <site><string>

Plural: urls
Returns the Locator found in the masthead. A site locator is used to synchronize with the site. It normally contains the URL of a remote file system folder, or the URL of a cgi-bin program that provides a remote directory listing of the site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
version of <site><integer>

Plural: versions
Returns the version number of the site content.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

site group

The <site group> Inspectors return information on the automatic groups defined for a given site.

Creation Methods

DeclarationDescriptionPlatforms (?)
group <integer> of <site>Returns an object corresponding to the numbered group of the specified site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
id of <site group><integer>

Plural: ids
Returns the numeric ID of the specified site group. This is the number assigned to an automatic group when it is first defined.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
member of <site group><boolean>

Plural: members
Returns TRUE if the current computer is a member of the specified group.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

site version list

The <site version list> Inspectors examine the multidimensional version numbers (ManyVersions) that are used by the Database to reconcile reconnected sites after a DSA failback event.

Creation Methods

DeclarationDescriptionPlatforms (?)
<string> as site version listConverts a string into a site version list.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
site version list <string>Returns a textual representation of a site version list ("manyversion").Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
site version list of <site>Returns the last gathered site version list (manyversion) of the specified site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <site version list>Returns the maximum value from a list of <site version list> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <site version list>Returns the minimum value from a list of <site version list> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<site version list> {cmp} <site version list><boolean>Compares two site version lists, component by component, where {cmp} is one of: <, <=, =.Win, Lin, Sol, HPUX, AIX, Mac, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<site version list> as string<string>Converts a site version list to a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
component <integer> of <site version list><integer>

Plural: components
Returns the nth element (as specified by <integer>) of the given site version list.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
extrema of <site version list><( site version list, site version list )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <site version list> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <site version list><site version list>

Plural: maxima
Returns the maximum value from a list of <site version list> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <site version list><site version list>

Plural: minima
Returns the minimum value from a list of <site version list> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <site version list><site version list with multiplicity>

Plural: unique values
Returns the unique values of a given list of <site version list> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

site version list with multiplicity

The <site version list with multiplicity> Inspectors deal with site-version-list arrays, allowing you to extract unique site-version-list values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <site version list>Returns the unique values of a given list of <site version list> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <site version list with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <site version list> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

bes site

The site Inspectors return the names and IDs of the specified site objects. As of BES 7.0, the BES custom site type has been merged with BES site, which now represents all supported types, including external sites, master action sites, operator sites, and custom sites. All properties of BES custom site are now accessible via BES site. As a compatibility measure, BES sites still returns only external and master action sites.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

bes site set

The <bes site set> Inspectors iterate over the BES sites and return a set of such sites.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

bes site with multiplicity

The <bes site with multiplicity> Inspectors deal with arrays of BES sites, allowing you to extract unique properties and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)